Short

class Short : Number, Comparable<Short>

Represents a 16-bit signed integer. On the JVM, non-nullable values of this type are represented as values of the primitive type short.

Types

Companion
Link copied to clipboard
object Companion

Functions

compareTo
Link copied to clipboard
operator fun compareTo(other: Byte): Int
operator fun compareTo(other: Double): Int
operator fun compareTo(other: Float): Int
operator fun compareTo(other: Int): Int
operator fun compareTo(other: Long): Int
open operator override fun compareTo(other: Short): Int

Compares this value with the specified value for order. Returns zero if this value is equal to the specified other value, a negative number if it's less than other, or a positive number if it's greater than other.

dec
Link copied to clipboard
operator fun dec(): Short

Decrements this value.

div
Link copied to clipboard
operator fun div(other: Byte): Int
operator fun div(other: Int): Int
operator fun div(other: Long): Long
operator fun div(other: Short): Int

Divides this value by the other value, truncating the result to an integer that is closer to zero.

operator fun div(other: Double): Double
operator fun div(other: Float): Float

Divides this value by the other value.

inc
Link copied to clipboard
operator fun inc(): Short

Increments this value.

minus
Link copied to clipboard
operator fun minus(other: Byte): Int
operator fun minus(other: Double): Double
operator fun minus(other: Float): Float
operator fun minus(other: Int): Int
operator fun minus(other: Long): Long
operator fun minus(other: Short): Int

Subtracts the other value from this value.

plus
Link copied to clipboard
operator fun plus(other: Byte): Int
operator fun plus(other: Double): Double
operator fun plus(other: Float): Float
operator fun plus(other: Int): Int
operator fun plus(other: Long): Long
operator fun plus(other: Short): Int

Adds the other value to this value.

rangeTo
Link copied to clipboard
operator fun rangeTo(other: Byte): IntRange
operator fun rangeTo(other: Int): IntRange
operator fun rangeTo(other: Long): LongRange
operator fun rangeTo(other: Short): IntRange

Creates a range from this value to the specified other value.

rem
Link copied to clipboard
operator fun rem(other: Byte): Int
operator fun rem(other: Double): Double
operator fun rem(other: Float): Float
operator fun rem(other: Int): Int
operator fun rem(other: Long): Long
operator fun rem(other: Short): Int

Calculates the remainder of truncating division of this value by the other value.

Since Kotlin

1.1
times
Link copied to clipboard
operator fun times(other: Byte): Int
operator fun times(other: Double): Double
operator fun times(other: Float): Float
operator fun times(other: Int): Int
operator fun times(other: Long): Long
operator fun times(other: Short): Int

Multiplies this value by the other value.

toByte
Link copied to clipboard
open override fun toByte(): Byte

Converts this Short value to Byte.

toChar
Link copied to clipboard
@DeprecatedSinceKotlin(warningSince = "1.5")
open override fun toChar(): Char

Converts this Short value to Char.

toDouble
Link copied to clipboard
open override fun toDouble(): Double

Converts this Short value to Double.

toFloat
Link copied to clipboard
open override fun toFloat(): Float

Converts this Short value to Float.

toInt
Link copied to clipboard
open override fun toInt(): Int

Converts this Short value to Int.

toLong
Link copied to clipboard
open override fun toLong(): Long

Converts this Short value to Long.

toShort
Link copied to clipboard
open override fun toShort(): Short

Returns this value.

unaryMinus
Link copied to clipboard
operator fun unaryMinus(): Int

Returns the negative of this value.

unaryPlus
Link copied to clipboard
operator fun unaryPlus(): Int

Returns this value.

Extensions

and
Link copied to clipboard
infix inline fun Short.and(other: Short): Short

Performs a bitwise AND operation between the two values.

coerceAtLeast
Link copied to clipboard
fun Short.coerceAtLeast(minimumValue: Short): Short

Ensures that this value is not less than the specified minimumValue.

coerceAtMost
Link copied to clipboard
fun Short.coerceAtMost(maximumValue: Short): Short

Ensures that this value is not greater than the specified maximumValue.

coerceIn
Link copied to clipboard
fun Short.coerceIn(minimumValue: Short, maximumValue: Short): Short

Ensures that this value lies in the specified range minimumValue..maximumValue.

convert
Link copied to clipboard
inline external fun <R : Any> Short.convert(): R
countLeadingZeroBits
Link copied to clipboard
inline fun Short.countLeadingZeroBits(): Int

Counts the number of consecutive most significant bits that are zero in the binary representation of this Short number.

countOneBits
Link copied to clipboard
inline fun Short.countOneBits(): Int

Counts the number of set bits in the binary representation of this Short number.

countTrailingZeroBits
Link copied to clipboard
inline fun Short.countTrailingZeroBits(): Int

Counts the number of consecutive least significant bits that are zero in the binary representation of this Short number.

downTo
Link copied to clipboard
infix fun Short.downTo(to: Byte): IntProgression
infix fun Short.downTo(to: Int): IntProgression
infix fun Short.downTo(to: Long): LongProgression
infix fun Short.downTo(to: Short): IntProgression

Returns a progression from this value down to the specified to value with the step -1.

floorDiv
Link copied to clipboard
inline fun Short.floorDiv(other: Byte): Int
inline fun Short.floorDiv(other: Short): Int
inline fun Short.floorDiv(other: Int): Int
inline fun Short.floorDiv(other: Long): Long

Divides this value by the other value, flooring the result to an integer that is closer to negative infinity.

inv
Link copied to clipboard
inline fun Short.inv(): Short

Inverts the bits in this value.

mod
Link copied to clipboard
inline fun Short.mod(other: Byte): Byte
inline fun Short.mod(other: Short): Short
inline fun Short.mod(other: Int): Int
inline fun Short.mod(other: Long): Long

Calculates the remainder of flooring division of this value by the other value.

or
Link copied to clipboard
infix inline fun Short.or(other: Short): Short

Performs a bitwise OR operation between the two values.

rotateLeft
Link copied to clipboard
fun Short.rotateLeft(bitCount: Int): Short

Rotates the binary representation of this Short number left by the specified bitCount number of bits. The most significant bits pushed out from the left side reenter the number as the least significant bits on the right side.

rotateRight
Link copied to clipboard
fun Short.rotateRight(bitCount: Int): Short

Rotates the binary representation of this Short number right by the specified bitCount number of bits. The least significant bits pushed out from the right side reenter the number as the most significant bits on the left side.

takeHighestOneBit
Link copied to clipboard
inline fun Short.takeHighestOneBit(): Short

Returns a number having a single bit set in the position of the most significant set bit of this Short number, or zero, if this number is zero.

takeLowestOneBit
Link copied to clipboard
inline fun Short.takeLowestOneBit(): Short

Returns a number having a single bit set in the position of the least significant set bit of this Short number, or zero, if this number is zero.

toString
Link copied to clipboard
expect fun Short.toString(radix: Int): String

Returns a string representation of this Short value in the specified radix.

actual inline fun Short.toString(radix: Int): String

Returns a string representation of this Short value in the specified radix.

actual inline fun Short.toString(radix: Int): String

Returns a string representation of this Short value in the specified radix.

actual inline fun Short.toString(radix: Int): String

Returns a string representation of this Short value in the specified radix.

toUByte
Link copied to clipboard
inline fun Short.toUByte(): UByte

Converts this Short value to UByte.

toUInt
Link copied to clipboard
inline fun Short.toUInt(): UInt

Converts this Short value to UInt.

toULong
Link copied to clipboard
inline fun Short.toULong(): ULong

Converts this Short value to ULong.

toUShort
Link copied to clipboard
inline fun Short.toUShort(): UShort

Converts this Short value to UShort.

until
Link copied to clipboard
infix fun Short.until(to: Byte): IntRange
infix fun Short.until(to: Int): IntRange
infix fun Short.until(to: Long): LongRange
infix fun Short.until(to: Short): IntRange

Returns a range from this value up to but excluding the specified to value.

xor
Link copied to clipboard
infix inline fun Short.xor(other: Short): Short

Performs a bitwise XOR operation between the two values.